Skip to main content

General Contribution Guidelines

How to Contribute​

Reporting Bugs​

If you find a bug in the source code or a mistake in the documentation, you can help by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Suggesting Enhancements​

If you have an idea for an enhancement, you can suggest it by opening an issue. Provide as much detail as possible to help us understand your idea and its benefits.

Pull Requests​

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-feature-branch
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Commit your changes: git commit -am 'Add new feature'
  6. Push to the branch: git push origin my-feature-branch
  7. Create a new Pull Request.

Commit Messages​

Please write meaningful commit messages. Follow these guidelines:

  • Start with JIRA ticket number if on the study compass team.
  • Limit the subject line to 50 characters.
  • Make sure commit messages are semantic, write about the why and how

Documentation​

If you are adding or changing functionality, update the documentation accordingly.

Tests​

Ensure that your changes include tested results. Run all possible tests to make sure your changes don't break anything else.